v1

latestOpenAPI 3.1.02026-08-042010999.7 KB

Utilities

Perform a test delivery of your webhook connection

This endpoint causes a webhook message to be delivered to your configured webhook target. It will be delivered from the same network and with the same options as real webhooks. This operation is asynchronous; it will return a 200 when it queues the test event, even if the webhook then fails or if no webhook is configured on your account. Tests will not be retried.

get/utils/send-webhook-test"

Response

messagestring

Status message. Use the response code to determine success or failure.

orgIDstring

The ID of the organization that owns the webhook.

Example response

{
  "message": "Test webhook message sent successfully",
  "orgID": "my-company"
}